/*
 * Copyright (c) 2009, Jan Pastor. All Rights Reserved.
 */
package sk.jp.commons.exception;

/**
 * BaseRuntimeException is base class for custom runtime exceptions.
 * <p>
 * Use this class or its subclasses when you want to throw
 * <code>RuntimeException</code> in application logic.
 * <p>
 * BaseRuntimeException is the superclass of those exceptions that can be thrown
 * during the normal operation of the Java Virtual Machine.
 * <p>
 * A method is not required to declare in its throws clause any subclasses of
 * RuntimeException that might be thrown during the execution of the method but
 * not caught.
 * 
 * @author Jan Pastor
 */
public class BaseRuntimeException extends RuntimeException {

    private static final long serialVersionUID = 1L;

    /**
     * Constructs a new runtime exception with <code>null</code> as its detail
     * message. The cause is not initialized, and may subsequently be
     * initialized by a call to {@link #initCause}.
     */
    public BaseRuntimeException() {
    }

    /**
     * Constructs a new runtime exception with the specified detail message. The
     * cause is not initialized, and may subsequently be initialized by a call
     * to {@link #initCause}.
     * 
     * @param message the detail message. The detail message is saved for later
     *            retrieval by the {@link #getMessage()} method.
     */
    public BaseRuntimeException(String message) {
        super(message);
    }

    /**
     * Constructs a new runtime exception with the specified cause and a detail
     * message of <tt>(cause==null ? null : cause.toString())</tt> (which
     * typically contains the class and detail message of <tt>cause</tt>).
     * This constructor is useful for runtime exceptions that are little more
     * than wrappers for other throwables.
     * 
     * @param cause the cause (which is saved for later retrieval by the
     *            {@link #getCause()} method). (A <tt>null</tt> value is
     *            permitted, and indicates that the cause is nonexistent or
     *            unknown.)
     */
    public BaseRuntimeException(Throwable cause) {
        super(cause);
    }

    /**
     * Constructs a new runtime exception with the specified detail message and
     * cause.
     * <p>
     * Note that the detail message associated with <code>cause</code> is
     * <i>not</i> automatically incorporated in this runtime exception's detail
     * message.
     * 
     * @param message the detail message (which is saved for later retrieval by
     *            the {@link #getMessage()} method).
     * @param cause the cause (which is saved for later retrieval by the
     *            {@link #getCause()} method). (A <tt>null</tt> value is
     *            permitted, and indicates that the cause is nonexistent or
     *            unknown.)
     */
    public BaseRuntimeException(String message, Throwable cause) {
        super(message, cause);
    }

}
